home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 May / Macworld (1998-05).dmg / Shareware World / Comms & Internet / Snak 1.3.1 / Snak Manual 1.3 / Snak Manual 1.3.rsrc / TEXT_136.txt < prev    next >
Text File  |  1998-02-16  |  3KB  |  51 lines

  1.  
  2.  
  3. Using Scripting
  4. Understanding scripting will give you a great set of new abilities and ways to use Snak. A script is a mini-program with variables and functions. An alias is one kind of a script, an entry in the Tools menu is another. An alias complements the built in commands and is used on equal terms.
  5.  
  6. Introduction
  7. A simple example is the /j alias. If you look in the Alias preference panel you'll see that it is defined as "/join $0".  /join is a built in command and can be used on the input line with a parameter, and so can /j. The $0 is a scripting variable, and will be explained later.
  8.  
  9. For a more elaborate example, look in the Clicking preference panel and note that you can customize what happens when you double click on a user. The default command for a double click in the notify list is "ConsoleClick". ConsoleClick is an alias, which is defined as "/msg $E $0-". 
  10.  
  11. This looks cryptic, but remember that a /msg always takes two pieces of input : the nick and the message. When Snak interprets the alias it replaces $E with the currently selected nick, and $0- with the contents of the input line.
  12.  
  13. Definition
  14. An Alias is a command or sequence of commands that you invoke by typing the alias name in the input line
  15.  
  16. Aliases can be complex multi-line mini-programs or they can simply be used to abbreviate frequently used commands. 
  17.  
  18. For example the alias "/j $0" will be translated to "/join #channelname" if you type "/j #channelname" into the input field. 
  19.  
  20. The "$0" in the above is a "scripting variable" and it will be replaced by the corresponding argument from the input line. $0 will be replaced by the first argument, $1 will be replaced by the second argument and so on.
  21.  
  22. To see what an alias can do, please open the Preferences window and go to the Alias panel. Snak comes with a list of pre-defined aliases that makes use of the scripting variables. 
  23.  
  24. One of the pre-defined aliases is the /j described above, and another, slightly more complex alias is /e.
  25.  
  26. Double click on the line with the "e" alias to bring up an Edit alias dialog. /e is a two line alias where the first line is an action and the second line is a normal channel message.  Snak queues the individual commands in multi-line aliases and sends then to the channel sequentially.
  27.  
  28. So if you were to type "/e lasagne" into the input field, Snak would queue two messages. The first would be an action message "<nickname> eats lasagne", and the second line would be a normal channel message "*BURP*". Apologies for my atrocious table  manners . . . .
  29.  
  30. In the Edit Alias window you can make changes and save them with OK.
  31.  
  32. Scripting Variables
  33. Snak supports numerical variables $0 thru $9
  34. The numerical variables can be used individually or in ranges:
  35. $n- gives argument n through the last argument
  36. $n-m gives arguments n through m
  37. $-m gives the first argument through m
  38.  
  39. $.      Nick of the last person to whom you sent a message
  40. $,      Nick of the last person who sent you a message
  41. $:      Nick of the last person who joined the channel
  42. $:      Nick of the last person who sent a message to the channel
  43.  
  44. $B     Text of the last message you sent
  45. $C   The name of the channel
  46. $E     Nick of the first selected user in the userlist
  47. $F     User and host information about the first selected user in the userlist
  48.  
  49. $I    Name of the channel you were last invited to join
  50. $N    Your nick
  51.